<?php
# ***** BEGIN LICENSE BLOCK *****
# This file is part of "myWiWall".
# Copyright (c) 2007-2008 CRP Henri Tudor and contributors.
# All rights reserved.
#
# "myWiWall" is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as published by
# the Free Software Foundation.
# 
# "myWiWall" is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with "myWiWall"; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# ***** END LICENSE BLOCK *****

?>
<div class="section">
<h1><?php echo __("Online help"); ?></h1>
<h2 id="table-of-content">Table of Content</h2>
<ul id="help_toc">
	<li><a href="#before-reading" title="Forewords">Forewords</a></li>
	<li><a href="#login" title="The authentication form">The authentication form</a></li>
	<li><a href="#widget-wall" title="The widget wall">The widget wall</a>
		<ul>
			<li><a href="#add-widget" title="Add widgets">Add widgets</a></li>
			<li><a href="#control-panel" title="The control panel">The control panel</a>
				<ul>
					<li><a href="#access-help" title="Access to online help">Access to online help</a></li>
					<li><a href="#logoff" title="Disconnect from the portal">Disconnect from the portal</a></li>
					<li><a href="#access-admin" title="Access to portal administration">Access to portal administration</a></li>
				</ul>
			</li>
			<li><a href="#widgets-zone" title="The widget zone">The widget zone</a>
				<ul>
					<li><a href="#organization" title="Widgets organization">Widgets organization</a></li>
					<li><a href="#drag-drop" title="Move the widgets">Displacement of widgets</a></li>
				</ul>
			</li>
		</ul>
	</li>
	<li><a href="#widgets" title="Widgets">Widgets</a>
		<ul>
			<li><a href="#window-system" title="The window system">The window system</a></li>
			<li><a href="#action-buttons" title="Action buttons">Action buttons</a></li>
			<li><a href="#widget-config" title="Widget configuration">Widget configuration</a></li>
		</ul>
	</li>
</ul>
<h2 id="before-reading">Forewords</h2>
<p>	
	This online documentation aims at end-users of the MyWiWall portal. 
	The words or groups of words appearing in the form of hyper-text links
	let you navigate to a Detailed definition of a concept.
	Do not hesitate to click on a term with which you are not familiar, to then
	continue your learning.
</p>
<p>	
	For any problem or constructive remark, please send an email
	to jerome.bogaerts at tudor dot lu.
</p>
<p>
	The myWiWall portal developement team wishes you a pleasant reading.
</p>

<h2 id="login">The login form</h2>
<p>	
	To access your dedicated web space on the portal, you must first
	be authenticate against the system. To do this, a login form is at your disposal. 
	It is composed of two text fields and a button that are respectively dedicated to: provide your user ID,
	provide your password and finally, validate the connection.
</p>
<p>	
	When your IDs are properly approved by the system, you will be
	automatically redirected to your dedicated widget wall. Otherwise, a message inviting you to recapture 
	your IDs is shown above the authentication form.
</p>


<h2 id="widget-wall">The widget wall</h2>
<p>
	The main screen of the portal is what we call the "widget wall". It is there that <a href="#widgets">widgets</a> you chose to use will be displayed.
</p>
<p>	
	The "widget wall" screen is divided into 3 distinct parts: "<a href="#add-widget">Add widgets</a>",
	"<a href="#control-panel">The control panel</a>" and "<a href="#widgets-zone">The widgets zone</a>" which are described in
	the following sections of this online help.
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-interface.png"/>
	<span class="legend">The widget wall with the "adding of widgets"(1), the "control panel"(2) and the "widgets zone"(3).</span>
</p>

<h3 id="add-widget">Add widgets</h3>
<p>	
	In the upper left corner of your screen is the tool of "Adding widgets."
	With the form of a menu, it displays a list of all the
	<a href="#widgets">widgets</a> you can use. To add a widget to your wall, select a name 
	from the list, and click on "Add widget." Note that if the previously selected widget is already in 
	your widgets zone, a will appear message to warn you and the adding
	will not be effective. After pressing the add button, you will find your widget
	ready for use in the area of widgets.
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-addwidget.png"/>
	<span class="legend">The drop-down list displaying the selectable widgets.</span>
</p>
<p>	
	There is a special type of widgets using the mechanism of "automatic authentication."
	These <a href="#widgets">widgets</a> may have to provide your unique user identifier to secure servers,
	in order to ensure the delivery of services that you can use through them. So if you add 
	this type of widget to your wall, a message will warn you and will enable you to accept decline to use the widget.
</p>

<h3 id="control-panel">The control pannel</h3>
<p>	
	The control panel shows your user ID, and a slist of actions that you can
	undertake on the portal. These actions are by default: "Online Help"
	"Logout, and finally, if you are an administrator of the portal,
	"Administration".
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-controlpanel.png"/>
	<span class="legend">The control panel located in the upper right corner of the widget wall.</span>
</p>

<h4 id="access-help">Access to online help</h4>
<p>
	By clicking the hyper-link "Online help", you will be automatically redirected to the myWiWall portal's online help.
</p>
<h4 id="logoff">Disconnect from the portal</h4>
<p>		
	Clicking on the hyperlink "Logout" has the effect of terminating the user session underway.
	Obviously, all the actions you have previously made on the portal will be persistently saved.
</p>

<h4 id="access-admin">Access to administration</h4>
<p>
	Clicking on the hyperlink "Administration" will return in the administration section of the portal,
	only if you're logged in as a portal administrator.
</p>

<h3 id="widgets-zone">The widget zone</h3>
<p>
	The widget zone is the most important point of the portal. It is in it that you can
	organize and use your range of previously instantiated <a href="#widgets">widgets</a>.
</p>

<h4 id="organization">Widgets organization</h4>
<p>
	The widget zone is organized in 3 columns, which can each contain an undetermined number of <a href="#widgets">widgets</a>.
	The columns of widgets are independent of each other and automatically adjust their size
	on their own depending on the size of widgets they contain. Through this columns, your widgets
	are organized efficiently, like a ready for use mosaic of applications.
</p>

<h4 id="drag-drop">Displacement of widgets</h4>
<p>	
	The displacement of widgets in the area of widgets is easy and intuitive. To move a widget,
	the application proposes to use the concept of "Drag & Drop". To displace a widget, simply click
	the title bar of the widget, move it up to the desired location in the widgets zone.
	When the position marked with a dashed rectangle suits, release the mouse button.
	Do not hesitate to drag <a href="#widgets">widgets</a> to sites already occupied by other widget instances. Indeed, you will
	notice that the widgets are reorganized automatically to make room for the moved widget.
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-dragdrop.png"/>
	<span class="legend">Example of moving a widget from one column to another using the "Drag & Drop" technique.</span>
</p>

<h2 id="widgets">Widgets</h2>
<p>	
	Widgets or gadgets, and in the case of the myWiWall portal, web widgets, are
	interactive applications carried out in order to view or update data on the Internet, that 
	users can simply use through a web document.
</p>
<p>	
	There are many web widgets, that users can easily use
	through widget engines, such as the MyWiWall portal. These web widgets provide
	users access to online services such as real-time weather, stock quotes,
	Reading RSS feeds, and many others.
</p>
<p>		
	In MyWiWall, widgets are displayed in windows, as we can see them in systems
	Operating like GNU Linux or Microsoft Windows. These windows are made up of a title bar,
	and buttons for actions triggering such as <a href="#widget-config">preferences</a>,
	<a href="#action-buttons">close</a>, <a href="#action-buttons">minimize</a> or <a href="#action-buttons">maximize</a> a widget.
</p>
<p>		
	Widgets can be arranged on the screen to form composite user interfaces that
	will enable users to complete business goals with a more or less fine granularity, or
	simply learn, have fun, ...
</p>

<h3 id="window-system">The window system</h3>
<p>
	The widgets are displayed in the form of windows. They contain a title bar
	to display the title of <a href="#widgets">widgets</a>, a not mandatory icon, and buttons. The
	windowing system will undoubtedly recall you your favorite operating system,
	so that you can easily find your marks in the myWiWall portal.
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-widget.png"/>
	<span class="legend">An "RSS reader" widget displayed as a window into myWiWall.</ span>
</p>

<h3 id="action-buttons">Action buttons</h3>
<p>
	By default, the window hosting a widget displays various action buttons.
	<ul class="iconified_list">
		<li>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-close.png"/>
			The "close" button allows you to withdraw your widget from the widget wall.
		</li>
		<li>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-minimize.png"/>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-maximize.png"/>	
			The "Minimize / Maximize" button is used to minimize or maximize the size of the window containing the <a href="#widgets">widget</a>.
			If the window containing the application widget is open, clicking the button will reduce
			the height of the window to see nothing but the title bar. If the window containing the widget is minimized,
			clicking on the button will give it back its original size.
		</li>
		<li>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-mail.png"/>
			The "Send an email to the author" allows you to send an email to the author of the widget
		</li>
		<li>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-edit.png"/>
			The "Edit" action button allows you to access to widget configuration:
		</li>
	</ul>
</p>
<p>
	In addition to these 4 action buttons displayed by each window housing a widget, an other button 
	depending on the implementation of the widget may appear. If activated by the author of widget:
	<ul class="iconified_list">
		<li>
			<img class="caputre" src="../../views/common/onlinehelp/img/icon-close.png"/>		
			The "Alternative URL" action button allows access to an alternative web page relevant to the widget.
			Once clicked the button, your browser will load in a new window this alternative address 
			that could accommodate, for example, a version of the complete application, or
			further information on the widget in the form of frequently asked questions.
		</li>
	</ul>
</p>

<h3 id="widget-config">Widget configuration</h3>
<p>		
	By clicking "Edit" in the title bar of a widget, you go
	to its configuration space. If widget preferences can be modified,
	series of configuration settings are displayed. Enter the appropriate data
	depending on the implementation of the widget and click "Save". The system
	is responsive and intelligent. If a data entry for a parameter
	is not compatible with the widget, you'll be automatically notified, and you'll be
	invited to enter a more appropriate value.
	
	<img class="capture" src="../../views/common/onlinehelp/img/capture-preferences.png"/>
	<span class="legend">Press the "Edit" action button lets you set your widget preferences.</span>
</p>
<p>	
	You also will notice the presence of fields called "tags". Those ones allow you
	to associate keywords to your widgets. Do not hesitate to use them, because they are
	then shared with other portal's users through the "TagCloud" widget
	built in myWiWall, which offers users the opportunity to seek
	widgets that might interest them using keyword clouds.
</p>
</div>